Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Boost: Add edge-cache header on WP Cloud #40557

Merged
merged 6 commits into from
Dec 20, 2024
Merged

Boost: Add edge-cache header on WP Cloud #40557

merged 6 commits into from
Dec 20, 2024

Conversation

haqadn
Copy link
Contributor

@haqadn haqadn commented Dec 11, 2024

Proposed changes:

  • If it's a WP Cloud site, add a header that helps cache the minified file.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

pfFwAW-nW-p2#comment-245

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • Install it on a WPCOM site.
  • Enable minify JS/CSS.
  • Check the header on _jb_static files that loads.
  • A8c-Edge-Cache: cache header should be present.

@haqadn haqadn requested a review from a team December 11, 2024 00:40
@haqadn haqadn self-assigned this Dec 11, 2024
@github-actions github-actions bot added the [Plugin] Boost A feature to speed up the site and improve performance. label Dec 11, 2024
Copy link
Contributor

github-actions bot commented Dec 11, 2024

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖


The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.


Follow this PR Review Process:

  1. Ensure all required checks appearing at the bottom of this PR are passing.
  2. Choose a review path based on your changes:
    • A. Team Review: add the "[Status] Needs Team Review" label
      • For most changes, including minor cross-team impacts.
      • Example: Updating a team-specific component or a small change to a shared library.
    • B. Crew Review: add the "[Status] Needs Review" label
      • For significant changes to core functionality.
      • Example: Major updates to a shared library or complex features.
    • C. Both: Start with Team, then request Crew
      • For complex changes or when you need extra confidence.
      • Example: Refactor affecting multiple systems.
  3. Get at least one approval before merging.

Still unsure? Reach out in #jetpack-developers for guidance!


Boost plugin:

  • Next scheduled release: none scheduled.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions github-actions bot added the [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! label Dec 11, 2024
@@ -60,6 +60,9 @@ function jetpack_boost_page_optimize_service_request() {
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
$etag = '"' . md5( file_get_contents( $cache_file ) ) . '"';

if ( defined( 'IS_ATOMIC' ) && IS_ATOMIC ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think IS_ATOMIC is defined on Pressable sites FYI.

@donnchawp
Copy link
Contributor

I tried it on my test wpcom site with upgrades and I didn't see the header, but it appears to be because Config::can_use_cache(); returned false. Investigating..

@haqadn haqadn requested a review from thingalon December 13, 2024 17:50
@haqadn
Copy link
Contributor Author

haqadn commented Dec 13, 2024

I have instead used the ATOMIC_CLIENT_ID constant, which is available on both Atomic and Pressable. However, I couldn't see the header even when I removed the condition and served the header all the time in atomic. Is the header filtered out by the edge? @thingalon

I also noticed that the files aren't cached in wpcom, which is a bummer. I think this will get resolved when we start serving from static files. boost-cache directory seems to be doing just fine. @thingalon previously recommended serving from inside the uploads folder. Do you see any downsides to serving from wp-content/boost-cache?

@haqadn haqadn added [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it and removed [Status] Needs Author Reply We would need you to make some changes or provide some more details about your PR. Thank you! labels Dec 13, 2024
@dilirity dilirity added this to the boost/next milestone Dec 18, 2024
@donnchawp
Copy link
Contributor

I think the boost-cache directory is probably a good place to put these files. We can be in complete control of them, and we'll be sure we're not interfering with files from either the blog or another plugin.
If we rely on the 404 handler to regenerate static files then wp-content/boost-cache/ and a sub directory like static will be easy to identify.
However, if we do this, then we have to be sure that the boost-cache directory itself isn't removed if the "Page Cache" module is toggled off.

@thingalon
Copy link
Member

thingalon commented Dec 20, 2024

Ah, sorry I missed this last week @haqadn. :)

I have instead used the ATOMIC_CLIENT_ID constant, which is available on both Atomic and Pressable. However, I couldn't see the header even when I removed the condition and served the header all the time in atomic. Is the header filtered out by the edge? @thingalon

Yes, we strip that header out on its way through the Edge. However, you can check if a given request was cached or not by looking at the x-ac header in the response.

If you request the same URL a few times and see HIT in there, you know that you've successfully hit the cache. :) Make sure you're not authenticated, as a login cookie causes a cache bypass. Using curl should do it.

I also noticed that the files aren't cached in wpcom, which is a bummer. I think this will get resolved when we start serving from static files. boost-cache directory seems to be doing just fine. @thingalon previously recommended serving from inside the uploads folder. Do you see any downsides to serving from wp-content/boost-cache?

I believe that wp-content/boost-cache should be fine.

I'm not sure which files aren't being cached on wpcom; if you can send me details, I can help out with that.

Copy link
Member

@dilirity dilirity left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This works on Atomic and Pressable.

:shipit:

@haqadn haqadn merged commit acacbbe into trunk Dec 20, 2024
62 checks passed
@haqadn haqadn deleted the add/edge-cache-header branch December 20, 2024 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Plugin] Boost A feature to speed up the site and improve performance. [Type] Enhancement Changes to an existing feature — removing, adding, or changing parts of it
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants